<?php
/**
 * This file houses the InputProtocol class.
 *
 * Copyright (c) 2010, Kalkomey Enterprises, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, this 
 *   list of conditions and the following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * - Neither the name of the Kalkomey Enterprises, Inc. nor the names of its 
 *   contributors may be used to endorse or promote products derived from this 
 *   software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 * @copyright Copyright (c) 2010, Kalkomey Enterprises, Inc.
 * @link http://code.google.com/p/swerv
 * @package Framework
 * @subpackage Library
 */

/**
 * The InputProtocol class is an abstract class used as the parent to all input protocol classes.
 *
 * @package Framework
 * @subpackage Library
 */
abstract class InputProtocol {
	
	/**
	 * Reads the incoming post data and converts it to a request object.
	 *
	 * @return Object
	 */
	abstract public function getInput($requestClassName);
	
	/**
	 * Reads the incoming post data and returns it.
	 *
	 * @return string
	 */
	protected function getRawPostData() {
		$data = file_get_contents('php://input');
		return $data;
	}
	
	/**
	 * Converts an array to an object.
	 * Note: this is a recursive function
	 * 
	 * @param array $arr the array to convert
	 * @param object &$requestObj the initial request object to store converted items into
	 *
	 * @return void
	 */
	protected function getArrayAsObject($arr, &$requestObj) {
		if (!is_array($arr)) {
			return false;
		}
		foreach ($arr as $propName => $value) {
			if (!is_array($value)) {
				$requestObj->$propName = $value;
			} else {
				$requestObj->$propName = new $propName();
				$this->getArrayAsObject($value, $requestObj->$propName);
			}
		}
	}
	
}
